/*
 * Copyright &copy; 2009-2011 Rebecca G. Bettencourt / Kreative Software
 * <p>
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * <a href="http://www.mozilla.org/MPL/">http://www.mozilla.org/MPL/</a>
 * <p>
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 * <p>
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU Lesser General Public License (the "LGPL License"), in which
 * case the provisions of LGPL License are applicable instead of those
 * above. If you wish to allow use of your version of this file only
 * under the terms of the LGPL License and not to allow others to use
 * your version of this file under the MPL, indicate your decision by
 * deleting the provisions above and replace them with the notice and
 * other provisions required by the LGPL License. If you do not delete
 * the provisions above, a recipient may use your version of this file
 * under either the MPL or the LGPL License.
 * @since PowerPaint 1.0
 * @author Rebecca G. Bettencourt, Kreative Software
 */

package com.kreative.paint.tool;

import java.awt.Cursor;
import java.awt.Graphics2D;
import java.awt.Image;
import com.kreative.paint.Layer;
import com.kreative.paint.PaintContextConstants;

public interface Tool extends PaintContextConstants {
	public String getName();
	public ToolCategory getCategory();
	public Image getIcon();
	public boolean validForPaintMode();
	public boolean validForDrawMode();
	
	public int getMouseHeldInterval();
	public boolean shiftConstrainsCoordinates();
	public boolean usesLetterKeys();
	public boolean paintIntermediateUsesCanvasCoordinates();
	public boolean doubleClickForOptions();
	public boolean pushPaintSelectionUponEntry();
	public boolean clearDrawSelectionUponEntry();
	
	public boolean toolSelected(ToolEvent e);
	public boolean toolDoubleClicked(ToolEvent e);
	public boolean toolDeselected(ToolEvent e);
	public boolean toolSettingsChanged(ToolEvent e);
	public boolean paintSettingsChanged(ToolEvent e);
	public boolean mouseEntered(ToolEvent e);
	public boolean mouseMoved(ToolEvent e);
	public boolean mousePressed(ToolEvent e);
	public boolean mouseHeld(ToolEvent e);
	public boolean mouseClicked(ToolEvent e);
	public boolean mouseDragged(ToolEvent e);
	public boolean mouseReleased(ToolEvent e);
	public boolean mouseExited(ToolEvent e);
	public boolean keyPressed(ToolEvent e);
	public boolean keyTyped(ToolEvent e);
	public boolean keyReleased(ToolEvent e);
	public boolean respondsToCommand(ToolEvent e);
	public boolean enableCommand(ToolEvent e);
	public boolean doCommand(ToolEvent e);
	public boolean paintIntermediate(ToolEvent e, Graphics2D g);
	public boolean showPaintSelection(ToolEvent e);
	public boolean showDrawSelection(ToolEvent e, Layer l);
	public Cursor getCursor(ToolEvent e);
}
